Prerequisites

Understanding of C++

The API and its Test Bench are written in C++, therefore knowledge and understanding of this language is essential to get the most out of the API.

Licensing

An active user account is required.

The API is free to download, but not free to use.

Warning: When running code created by the API, product licenses for LEGION Simulator and LEGION Simulator API are consumed and will be charged as LEGION Simulator usage. Users should check with their licensing admin regarding usage limits and be aware of overuse liabilities.

To run code created with the API, you must have entitlement for these products, and be signed into the Client (or have signed in within the last 7 days).

Visual Studio

You will need Visual Studio v15.9.13 or higher. Community Edition or higher is sufficient.

Warning: The API is tested for Visual Studio 2017 and Visual Studio 2019. Compatibility with other versions of Visual Studio (e.g., 2015, 2023, etc.) is unknown.

Specific Visual Studio Workloads and Individual Components are required. Please add the following Workloads and Individual Components using Visual Studio Installer:

Workloads:
- Desktop development with C++
Individual Components:
- Compilers, build tools, and runtime
  - C++/CLI support
  - MSBuild
  - Windows Universal CRT SDK
  - Windows XP Support for C++
- Development Activities
  - Visual C++ core features
- SDKs, libraries, and frameworks